Skip to content

Vale style audit: fix warnings from PRs merged in the last week#6278

Merged
ethanpalm merged 4 commits into
mainfrom
mintlify/fix-vale-warnings-2026-06-25
Jun 25, 2026
Merged

Vale style audit: fix warnings from PRs merged in the last week#6278
ethanpalm merged 4 commits into
mainfrom
mintlify/fix-vale-warnings-2026-06-25

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Audits Vale style warnings introduced by the 33 PRs merged into main between 2026-06-18 and 2026-06-25 (scope window from the vale-audit workflow) and applies confident, style-only fixes.

Changes

  • advanced-support.mdxWordList: lowercase Emailemail in the support tiers table cell (L14).
  • create/changelogs.mdxWordList: lowercase Emailemail in the RSS integrations bullet link label (L139).
  • ai/model-context-protocol.mdxEmDash: remove spaces around em-dash in the 4 tool annotation bullets (L173–L176).
  • guides/seo.mdxEmDash: remove spaces around em-dash in 4 SEO FAQ sentences (L149, L161, L165, L169).
  • optimize/seo.mdxEmDash: remove spaces around em-dash in the 3 Content-Signal opt-in bullets (L353–L355).
  • organize/settings-structure.mdxEmDash: remove spaces around em-dash in 20 contextual menu option bullets and $page / $path / $mcp placeholder bullets (L379–L395, L413–L415).

Total: 33 style-only corrections across 6 files.

Context

  • Triggered by .mintlify/workflows/vale-audit.md (scheduled run, window 2026-06-18T15:06:57Z2026-06-25T15:06:50Z).
  • Mirrors the precedent set by PR docs: fix Vale warnings from PRs merged in the last week #6222.
  • Only English .mdx files were considered. Files under es/, fr/, zh/, and changelog.mdx are out of scope per the workflow.
  • Rules implemented: WordList, Latin, Spelling, EmDash, Spacing, Ellipses, LyHyphens, OptionalPlurals, Ordinal, HeadingPunctuation (applied against .vale.ini SkippedScopes: fenced code, JSX tags, expressions, inline code, frontmatter, markdown link URLs).

Warnings left for human review

WordListregexregular expression

  • dashboard/sso.mdx L178| \groups` | Unspecified | Matches regex | `.*` |`

    The cell value Matches regex is a literal Okta SAML attribute-statement filter option (Matches regex is the exact label in the Okta admin UI). Rewriting to regular expression would misrepresent the product label, so this needs a human call.

Warnings inspected and dismissed as false positives

These were flagged by the lint pass but resolved as masking artifacts or scoping issues and not changed:

  • ai/markdown-export.mdx L70Spacing flagged a double-space artifact created by masking inline code (`.md`) between a sentence-ending period and the next capitalized word. The original source has a single space.
  • ai/model-context-protocol.mdx L410WordList flagged url inside an indented ```toml fenced code block (url = "<your-mcp-server-url>"), which is in scope per .vale.ini SkippedScopes = code.
  • deploy/authentication-setup.mdx L88, L93, L103, L104, L131WordList flagged OAuth 2 inside OAuth 2.0. The text already conforms to the rule (OAuth 2.0).

Note

Low Risk
Documentation-only punctuation and word-list capitalization with no runtime or configuration impact.

Overview
This PR applies Vale style-only fixes from a recent audit: mainly EmDash (tighten em dashes by dropping spaces around ) and a WordList tweak.

Em dash formatting is updated on bullet lists and in running copy—MCP tool annotation bullets, SEO FAQ answers, Content-Signal / noindex bullets, and long contextual.options lists in site-structure docs. The pattern changes from spaced em dashes () to unspaced () before the gloss text.

The same em-dash pass is mirrored in es/, fr/, and zh/ localized pages (MCP, SEO guides, SEO reference, settings structure). zh/create/changelogs.mdx also lowercases Email to email in an RSS integration bullet link label.

No product behavior, APIs, or config semantics change—only documentation punctuation and capitalization for the style linter.

Reviewed by Cursor Bugbot for commit a148205. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jun 25, 2026, 3:43 PM

@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
smartac 🟢 Ready View Preview Jun 25, 2026, 3:55 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview Jun 25, 2026, 4:22 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread create/changelogs.mdx Outdated
Comment thread advanced-support.mdx Outdated
@ethanpalm ethanpalm merged commit e015e2d into main Jun 25, 2026
6 checks passed
@ethanpalm ethanpalm deleted the mintlify/fix-vale-warnings-2026-06-25 branch June 25, 2026 16:24
@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
adminroletesting 🔴 Failed Jun 25, 2026, 4:44 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hfh-d7a4d643 🔴 Failed Jun 25, 2026, 5:03 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants